Skip to content

fix(bench): resolve TypeScript declaration lint errors#9320

Open
DivitJain26 wants to merge 10 commits intostdlib-js:developfrom
DivitJain26:fix/bench-indexed-test-cases
Open

fix(bench): resolve TypeScript declaration lint errors#9320
DivitJain26 wants to merge 10 commits intostdlib-js:developfrom
DivitJain26:fix/bench-indexed-test-cases

Conversation

@DivitJain26
Copy link
Contributor

@DivitJain26 DivitJain26 commented Dec 23, 2025 •
edited
Loading

Progresses #9110.

Description

What is the purpose of this pull request?

This pull request:

This pull request resolves TypeScript declaration lint errors in the benchmark harness typings.

  • Fixes tsdoc-declarations-doctest errors caused by undefined identifiers in examples
  • Updates TSDoc examples to correctly reference the exported main function
  • Adjusts examples to ensure variables used in doctests are properly scoped
  • Fixes @typescript-eslint/no-empty-function lint errors in TypeScript declaration tests by replacing empty arrow functions with explicit (): void => undefined
  • Ensures all declaration examples and tests pass TypeScript linting and doctest validation

These changes improve the correctness and reliability of the TypeScript declaration files without altering runtime behavior.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Questions

Any questions for reviewers of this pull request?

No.

Other

  • Changes are limited to TypeScript declaration files and their associated tests
  • No runtime JavaScript behavior is modified
  • All fixes follow existing stdlib TypeScript and documentation conventions

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

{{TODO: add disclosure if applicable}}

@stdlib-js/reviewers

@DivitJain26
fix(bench): update TS doc examples to reference benchmark argument
16b69da
@DivitJain26
fix(bench): update TS doc examples to reference exported variable main
0195fea
@DivitJain26
docs(bench): fix doctest annotations for Benchmark properties
fdad800
@DivitJain26
docs(tsdoc): fix doctest examples for Benchmark read-only properties
dca86d1
@DivitJain26
fix(bench): replace empty arrow functions with expression-bodied no-ops
e653b50 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Dec 23, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 23, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
bench/harness $\color{red}3550/3569$
$\color{green}+0.00%$ 		$\color{red}340/345$
$\color{green}+0.00%$ 		$\color{red}78/80$
$\color{green}+0.00%$ 		$\color{red}3550/3569$
$\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

@DivitJain26
fix(bench): replace empty arrow functions with expression-bodied no-ops
b051b95 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@DivitJain26
chore(types): remove any and eslint-disable from Benchmark assertions
181972d 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@DivitJain26
chore(types): restore eslint-disable for explicit any in Benchmark as…
a5f969f 
…sertions

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
kgryte
kgryte reviewed Dec 23, 2025
View reviewed changes
lib/node_modules/@stdlib/bench/harness/docs/types/index.d.ts Outdated
* @example
* b.comment( 'This is a comment.' );
* function benchmark( b ) {
* b.comment( 'This is a comment.' );
Copy link
Member

@kgryte kgryte Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throughout all of the examples changes in the docs, you are mixing tabs and spacing. You should only use space indentation in JSDoc comments. That will need to be updated throughout this file in this PR.

kgryte
kgryte requested changes Dec 23, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left an initial comment.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Dec 23, 2025
@DivitJain26
docs: replace tabs with spaces in JSDoc examples
796e21a 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@DivitJain26
Copy link
Contributor Author

DivitJain26 commented Dec 23, 2025

@kgryte I’ve updated all JSDoc examples to use spaces instead of tabs.

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 23, 2025

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged. For more information, see GitHub's documentation on using keywords in issues and pull requests.

Required action:
Use "Progresses" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

@DivitJain26
docs: replace tabs with spaces in JSDoc examples 2
e3332ec 
Signed-off-by: DivitJain26 <divit26j@gmail.com>
@DivitJain26
Copy link
Contributor Author

DivitJain26 commented Dec 25, 2025

@kgryte Is there something else I need to do?

@DivitJain26 DivitJain26 requested a review from kgryte December 25, 2025 04:35
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Dec 25, 2025
@DivitJain26
Copy link
Contributor Author

DivitJain26 commented Dec 28, 2025 •
edited
Loading

Hi @Planeshifter @kgryte , I’ve updated all JSDoc examples to use spaces as requested. Could you please review when convenient?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte Awaiting requested review from kgryte

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

Needs Changes Pull request which needs changes before being merged. Needs Review A pull request which needs code review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@DivitJain26 @stdlib-bot @kgryte